package com.ybbase.framework.service.flow;

import com.ybbase.framework.model.po.flow.InstanceRecord;
import com.ybbase.framework.model.vo.BusinessEntityVO;
import org.activiti.engine.impl.persistence.entity.ProcessDefinitionEntity;
import org.activiti.engine.impl.persistence.entity.TaskEntity;
import org.activiti.engine.impl.pvm.process.ActivityImpl;
import org.activiti.engine.runtime.ProcessInstance;
import org.activiti.engine.task.Task;

import java.util.List;
import java.util.Map;

/**
 * @author cg
 * @date 2019-08-26
 * 流程核心处理类
 * */
public interface ProcessCoreService {

    /**
     * 根据当前任务ID、退回节点ID、variables流程存储参数进行退回流程
     * @author cg
     * @date 2019-09-02 19:45
     * @param taskId 当前任务ID
     * @param activityId 退回节点ID
     * @param variables 流程存储参数
     * @param businessEntityVO 业务类
     * @throws Exception
     */
    void backProcess(String taskId, String activityId, Map<String, Object> variables,BusinessEntityVO businessEntityVO) throws Exception;

    /**
     * 根据当前任务ID、取回节点ID进行取回流程，撤回
     * @param
     * @return
     * @author cg
     * @date 2020-03-07 17:45
     * @since cloud2.0
     */
    public void executeCallBackProcess(String taskId,Map<String, Object> variables,String userID, String activityId, BusinessEntityVO businessEntityVO)throws Exception;

    /**
     * 提交流程/流程转向
     * @author cg
     * @date 2019-09-02 19:51
     * @param taskId 当前任务ID
     * @param variables 流程变量
     * @param activityId 流程转向执行任务节点ID，此参数为空，默认为提交操作
     * @param businessEntityVO 业务类
     * @throws Exception
     */
    void commitProcess(String taskId, Map<String, Object> variables, String activityId,BusinessEntityVO businessEntityVO) throws Exception;

    /**
     * 获取业务实例记录信息
     * @param businessEntityVO 业务Vo
     * @return
     * @author cg
     * @date 2019-09-27 17:25
     * @since 4.0
     */
    InstanceRecord getInstanceRecordByVO(BusinessEntityVO businessEntityVO);

    /**
     * 中止流程(特权人直接审批通过等)
     * @author cg
     * @date 2019-09-02 19:51
     * @param taskId 流程任务编码
     * @param businessEntityVO 业务类
     * @param variables 流程变量
     * @throws Exception
     */
    void endProcess(String taskId,Map<String, Object> variables, BusinessEntityVO businessEntityVO) throws Exception;

    /**
     * 根据流入任务集合，查询最近一次的流入任务节点
     * @author cg
     * @date 2019-09-02 19:52
     * @param processInstance 流程实例
     * @param tempList 流入任务集合
     * @return ActivityImpl 节点实现类
     */
    ActivityImpl filterNewestActivity(ProcessInstance processInstance, List<ActivityImpl> tempList);

    /**
     * 根据任务ID和节点ID获取活动节点
     * @author cg
     * @date 2019-09-02 20:06
     * @param taskId 任务ID
     * @param activityId 活动节点ID，如果为null或""，则默认查询当前活动节点，如果为"end"，则查询结束节点
     * @return ActivityImpl 节点实现类
     * @throws Exception
     */
    ActivityImpl findActivitiImpl(String taskId, String activityId) throws Exception;

    /**
     * 根据当前任务ID，查询可以退回的任务节点
     * @author cg
     * @date 2019-09-02 20:08
     * @param taskId 当前任务ID
     * @return List<ActivityImpl> 节点实现类集合
     * @throws Exception
     */
    List<ActivityImpl> findBackAvtivity(String taskId) throws Exception;

    /**
     * 根据任务ID获取流程定义
     * @author cg
     * @date 2019-09-02 20:11
     * @param taskId 任务ID
     * @return ProcessDefinitionEntity 流程定义实体类
     * @throws Exception
     */
    ProcessDefinitionEntity findProcessDefinitionEntityByTaskId(String taskId) throws Exception;

    /**
     * 根据任务ID获取对应的流程实例
     * @author cg
     * @date 2019-09-02 20:12
     * @param taskId 任务ID
     * @return ProcessInstance 流程实例实体
     * @throws Exception
     */
    ProcessInstance findProcessInstanceByTaskId(String taskId) throws Exception;

    /**
     * 根据任务ID获得任务实例
     * @author cg
     * @date 2019-09-02 20:13
     * @param taskId 任务ID
     * @return TaskEntity 任务实体
     * @throws Exception
     */
    TaskEntity findTaskById(String taskId) throws Exception;

    /**
     * 根据流程实例ID和任务key值查询所有同级任务集合
     * @author cg
     * @date 2019-09-02 20:14
     * @param processInstanceId 流程实例ID
     * @param key 任务定义的KEY
     * @return List<Task> 实例列表
     */
    List<Task> findTaskListByKey(String processInstanceId, String key);

    /**
     * 转办流程
     * @author cg
     * @date 2019-09-02 20:22
     * @param taskId 当前任务节点ID
     * @param userCode 被转办人Code
     */
    void transferAssignee(String taskId, String userCode);
}
